package com.mixpanel.android.java_websocket;

import java.net.InetSocketAddress;
import java.nio.ByteBuffer;

import com.mixpanel.android.java_websocket.drafts.Draft;
import com.mixpanel.android.java_websocket.exceptions.InvalidDataException;
import com.mixpanel.android.java_websocket.framing.Framedata;
import com.mixpanel.android.java_websocket.handshake.ClientHandshake;
import com.mixpanel.android.java_websocket.handshake.Handshakedata;
import com.mixpanel.android.java_websocket.handshake.ServerHandshake;
import com.mixpanel.android.java_websocket.handshake.ServerHandshakeBuilder;

/**
 * Implemented by <tt>WebSocketClient</tt> and <tt>WebSocketServer</tt>.
 * The methods within are called by <tt>WebSocket</tt>.
 * Almost every method takes a first parameter conn which represents the source of the respective event.
 */
public interface WebSocketListener {

    /**
     * Called on the server side when the socket connection is first established, and the WebSocket
     * handshake has been received. This method allows to deny connections based on the received handshake.<br>
     * By default this method only requires protocol compliance.
     *
     * @param conn    The WebSocket related to this event
     * @param draft   The protocol draft the client uses to connect
     * @param request The opening http message send by the client. Can be used to access additional fields like cookies.
     * @return Returns an incomplete handshake containing all optional fields
     * @throws InvalidDataException Throwing this exception will cause this handshake to be rejected
     */
    public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request) throws InvalidDataException;

    /**
     * Called on the client side when the socket connection is first established, and the WebSocketImpl
     * handshake response has been received.
     *
     * @param conn     The WebSocket related to this event
     * @param request  The handshake initially send out to the server by this websocket.
     * @param response The handshake the server sent in response to the request.
     * @throws InvalidDataException Allows the client to reject the connection with the server in respect of its handshake response.
     */
    public void onWebsocketHandshakeReceivedAsClient(WebSocket conn, ClientHandshake request, ServerHandshake response) throws InvalidDataException;

    /**
     * Called on the client side when the socket connection is first established, and the WebSocketImpl
     * handshake has just been sent.
     *
     * @param conn    The WebSocket related to this event
     * @param request The handshake sent to the server by this websocket
     * @throws InvalidDataException Allows the client to stop the connection from progressing
     */
    public void onWebsocketHandshakeSentAsClient(WebSocket conn, ClientHandshake request) throws InvalidDataException;

    /**
     * Called when an entire text frame has been received. Do whatever you want
     * here...
     *
     * @param conn    The <tt>WebSocket</tt> instance this event is occurring on.
     * @param message The UTF-8 decoded message that was received.
     */
    public void onWebsocketMessage(WebSocket conn, String message);

    /**
     * Called when an entire binary frame has been received. Do whatever you want
     * here...
     *
     * @param conn The <tt>WebSocket</tt> instance this event is occurring on.
     * @param blob The binary message that was received.
     */
    public void onWebsocketMessage(WebSocket conn, ByteBuffer blob);

    public void onWebsocketMessageFragment(WebSocket conn, Framedata frame);

    /**
     * Called after <var>onHandshakeReceived</var> returns <var>true</var>.
     * Indicates that a complete WebSocket connection has been established,
     * and we are ready to send/receive data.
     *
     * @param conn The <tt>WebSocket</tt> instance this event is occuring on.
     */
    public void onWebsocketOpen(WebSocket conn, Handshakedata d);

    /**
     * Called after <tt>WebSocket#close</tt> is explicity called, or when the
     * other end of the WebSocket connection is closed.
     *
     * @param conn The <tt>WebSocket</tt> instance this event is occuring on.
     */
    public void onWebsocketClose(WebSocket ws, int code, String reason, boolean remote);

    /**
     * called as soon as no further frames are accepted
     */
    public void onWebsocketClosing(WebSocket ws, int code, String reason, boolean remote);

    /**
     * send when this peer sends a close handshake
     */
    public void onWebsocketCloseInitiated(WebSocket ws, int code, String reason);

    /**
     * Called if an exception worth noting occurred.
     * If an error causes the connection to fail onClose will be called additionally afterwards.
     *
     * @param ex The exception that occurred. <br>
     *           Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.
     */
    public void onWebsocketError(WebSocket conn, Exception ex);

    /**
     * Called a ping frame has been received.
     * This method must send a corresponding pong by itself.
     *
     * @param f The ping frame. Control frames may contain payload.
     */
    public void onWebsocketPing(WebSocket conn, Framedata f);

    /**
     * Called when a pong frame is received.
     **/
    public void onWebsocketPong(WebSocket conn, Framedata f);

    /**
     * Gets the XML string that should be returned if a client requests a Flash
     * security policy.
     *
     * @throws InvalidDataException thrown when some data that is required to generate the flash-policy like the websocket local port could not be obtained.
     */
    public String getFlashPolicy(WebSocket conn) throws InvalidDataException;

    /**
     * This method is used to inform the selector thread that there is data queued to be written to the socket.
     */
    public void onWriteDemand(WebSocket conn);

    public InetSocketAddress getLocalSocketAddress(WebSocket conn);

    public InetSocketAddress getRemoteSocketAddress(WebSocket conn);
}
